Child Screening
Domain Message Specification

Version: 2.1; Status: RC3

BloodSpotScreening Tabular View

COCD_TP146005GB03
BloodSpotScreening

This template is used to carry blood spot screening results. It supports the extension of a wider range of test results to be sent as more become available.

This is achieved using a class with a HL7 attribute code* to describe the test carried out with an associated value* attribute to hold the test result and an interpretation code attribute to describe how the result should be interpreted. There is also a further optional class with a value* attribute that holds the status of the result.

*The code attribute is populated with concepts from the SNOMED CT subsets.

*The value attribute is populated with concepts from the NewbornBloodSpotScreeningResultStatus national vocabulary.

This template also allows for mapping from NewbornBloodSpotScreeningResultStatus to other terminologies such as SNOMED CT using the XML translation element.

The BloodSpotScreening class represents a battery of tests, as outlined by the NHS Newborn Blood Spot Screening Programme to identify babies that may have rare but serious diseases that respond to early treatment.
Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="BATTERY" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a battery.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "BATTERY".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as a battery event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:SnomedCT } )
{ Fixed="428447008" }

Model Attribute Description

The HL7 attribute code uses a code from SNOMED CT to describe this class as a blood spot screening.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value "428447008"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15"
  • The XML attribute displayName shall carry the description associated with the code. It is recommended that the preferred term is used to populate this attribute.
[1..1] [M] effectiveTime (TS)

Model Attribute Description

The HL7 attribute effectiveTime is used to indicate when the blood spot screening was done.

Implementation in XML Instance

The XML attribute value of the XML element effectiveTime shall be populated with the time that the blood spot screening was done using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes
Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.
[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an identifier to identify each instance of a blood spot battery.

Implementation in XML Instance

The Identifier Global data type flavour is used to carry this information in the XML element id as follows:

  • The XML attribute root shall contain a DCE UUID.
[1..1] [M] statusCode (CS { CNE:ActStatus } )
{ Fixed="completed" }
Model Attribute Description

The HL7 attribute code uses a code to describe the status of the blood spot screening.

Implementation in XML Instance

The Coded Simple (CS) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain a fixed value of "completed".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#BloodSpotScreening" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#BloodSpotScreening"
[0..1] author

This template class constrains the CDA author class.

The author of this information must be included if the author is different to the document (inherited) author.

If there is no known author for the information held on the source system then:

  • The information may be included and the document author will be deemed to be the author (by inheritance). The author should be asked to decide whether this is acceptable or not.
  • If the document author does not want to be considered as the author of the information then information must not be included in the document.
[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="AUT" }

Model Attribute Description

The HL7 attribute typeCode describes this class as an author participation.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "AUT".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description

The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd in the actRelationships is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding) - the author replaces any author that has been conducted from any previous acts.
  • "P" (Propagating) - the author is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

The XML attribute contextControlCode shall contain the value " OP"
[1..1] [M] contentId (II) { "NPFIT-000196#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] functionCode (CV { CNE:AuthorFunctionType } )
{ Fixed="OA" }

Model Attribute Description

The HL7 attribute functionCode uses a code from the vocabulary AuthorFunctionType to describe the function of the author

Implementation in XML Instance

The Coded Plain data type flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element functionCode as follows:

  • The XML attribute code is fixed to "OA"
  • The XML attribute codeSystem is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.17.178"
  • The XML attribute displayName is fixed to the author's function name "Originating Author".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#author" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#author"
[1..1] [R] time (TS)

Model Attribute Description

The HL7 attribute time is used to define the time the author originally recorded the blood spot screening results.

Implementation in XML Instance

The XML attribute value of the XML element time shall be populated with the time that author recorded the information using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

Where no time is recorded or available then:

The XML attribute nullFlavor of the XML element time shall contain the value "UNK"

[1..1] participant (AuthorChoice)
A link to the choice of authors.
[0..*] component

This template class constrains the CDA component entry class.

This class links the screening battery to the screening test result(s).
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="COMP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "COMP".
[1..1] [M] contextConductionInd (BL)
{ Fixed="true" }

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

  • The XML attribute contextConductionInd is fixed to "true".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#component" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#component"
[1..1] screening (Screening)
A link to the screening test result(s).
[0..1] component5

This template class constrains the CDA component entry class.

This class links the blood spot screening battery to the location status.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="COMP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "COMP".
[1..1] [M] contextConductionInd (BL)
{ Fixed="true" }

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

  • The XML attribute contextConductionInd is fixed to "true".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#component5" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#component5".
[1..1] locStatus (LocStatus)
A link to location status class.
[0..1] component6

This template class constrains the CDA component entry class.

This class links the blood spot screening battery to the laboratory card serial number.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="COMP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "COMP".
[1..1] [M] contextConductionInd (BL)
{ Fixed="true" }

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

  • The XML attribute contextConductionInd is fixed to "true".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#component6" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#component6".
[1..1] labCardSerialNum (LabCardSerialNum)
A link to laboratory card serial number class.
[0..1] component7

This template class constrains the CDA component entry class.

This class links the blood spot screening battery to the previous laboratory card serial number.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="COMP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "COMP".
[1..1] [M] contextConductionInd (BL)
{ Fixed="true" }

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

  • The XML attribute contextConductionInd is fixed to "true".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#component7" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#component7".
[1..1] prvLabCardSerialNum (PrvLabCardSerialNum)
A link to the previous laboratory card serial number class.
[0..1] performer

This template class constrains the CDA performer class.

This class refers to performer of the blood spot screening which is the person collecting the sample.

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="PRF" }

Model Attribute Description

The HL7 attribute typeCode describes this class as a performer participation.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "PRF".
[1..1] [M] contentId (II) { "NPFIT-000210#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#performer" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#performer".
[1..1] [R] time (TS)

Model Attribute Description

The HL7 attribute time is used to define the time the performer originally collected the blood spot screening sample.

Implementation in XML Instance

The XML attribute value of the XML element time shall be populated with the time that author recorded the information using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

Where no time is recorded or available then:

The XML attribute nullFlavor of the XML element time shall contain the value " UNK"
[1..1] participant (PerformerChoice)
A link to performer choice.
[0..1] secondaryPerformer

This template class constrains the CDA participant class.

The class refers to the secondary performer of the blood spot screening which is lab receiving the sample.

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="SPRF" }

Model Attribute Description

The HL7 attribute typeCode describes this class as a secondary performer participation.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "SPRF".
[1..1] [M] contentId (II) { "NPFIT-000211#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#secondaryPerformer" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#secondaryPerformer".
[1..1] [R] time (TS)

Model Attribute Description

The HL7 attribute time is used to define the time the secondary performer (lab) originally received the blood spot screening sample.

Implementation in XML Instance

The XML attribute value of the XML element time shall be populated with the time that author recorded the information using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

Where no time is recorded or available then:

The XML attribute nullFlavor of the XML element time shall contain the value " UNK"
[1..1] participant (SecPerformerChoice)
A link to secondary performer choice.
AuthorChoice
A choice of author templates.
Used by: BloodSpotScreening
[1..1] : Template1
An abstract placeholder for templates of authors.
Screening

This template class constrains the CDA Observation entry class.

This class represents the screening result.
Used by: BloodSpotScreening
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:NewbornBloodSpotScreeningTestProceduresSnCT } )

Model Attribute Description

The HL7 attribute code uses a code from NewbornBloodSpotScreeningTestProceduresSnCT vocabulary to describe the type of procedure, the status of which is carried in the HL7 attribute value of this class.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain a value from the "NewbornBloodSpotScreeningTestProceduresSnCT" vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15".
  • The XML attribute displayName may carry a description associated with the code in the subset stated in the "NewbornBloodSpotScreeningTestProceduresSnCT" vocabulary. It is recommended that the preferred term is used to populate this attribute.
[0..1] interpretationCode (CV { CNE:BSLaboratoryInterpretationCode } )

Model Attribute Description

The HL7 attribute code uses a code from the BSLaboratoryInterpretationCode vocabulary to describe how the procedure should be interptreted.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain a value from the BSLaboratoryInterpretationCode vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.490"
  • The XML attribute displayName shall carry the description associated with the code.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#screening" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2".
  • The XML attribute extension is fixed to "COCD_TP146005GB03#screening".
[1..1] [M] value (CD { CWE:NewbornBloodSpotScreeningResultStatus } )

Model Attribute Description

The HL7 attribute value uses a code from the NewbornBloodSpotScreeningResultStatus vocabulary to describe this as a Newborn Blood Spot Screening Result Status, this value is associated with the SNOMED CT concept carried in the HL7 attribute code of this class.

Implementation in XML Instance

The Concept Descriptor (CD) data type shall be used to carry this information in the XML element value as follows:

  • The XML attribute value shall contain a value from the "NewbornBloodSpotScreeningResultStatus" vocabulary.
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.512".
  • The XML attribute displayName shall carry the description associated with the code stated in the NewbornBloodSpotScreeningResultStatus vocabulary.
  • The XML element translation may be populated as follows to support alternate coding system representation of the same information.
    • For the Version 2 of the Read Codes (commonly known as READ2):
      • The XML attribute code shall contain the value from the READ2 coding scheme.
      • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.6.2".
      • The XML attribute displayName may carry the description associated with the code.
    • For the Version 3 of the Read Codes (commonly known as Clinical Terms Version 3,CTV3):
      • The XML attribute code shall contain the value from the CTV3 coding scheme.
      • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.14".
      • The XML attribute displayName may carry the description associated with the code.
    • For SNOMED CT concepts
      • The XML attribute code shall contain the value from the NewbornBloodSpotScreeningResultStatusSnCT subset.
      • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15".
      • The XML attribute displayName shall carry the description associated with the concept stated in the NewbornBloodSpotScreeningResultStatusSnCT subset. It is recommended that the preferred term is used to populate this attribute
    • For other coding systems (schemes):
      • The XML attribute code shall contain the value from the that coding scheme.
      • The XML attribute codeSystem shall contain the OID for that coding scheme.
      • The XML attribute displayName may carry the description associated with the code.
[0..1] entryRelationship1

This template class constrains the CDA entryRelationship class.

This class is a component class it is used to link observation class.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="COMP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "COMP".
[1..1] [M] contextConductionInd (BL)
{ Fixed="true" }

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

  • The XML attribute contextConductionInd is fixed to "true".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#entryRelationship1" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#entryRelationship1".
[1..1] screeningSubStatus (ScreeningSubStatus)
A link to the screening sub status class.
[0..1] entryRelationship2

This template class constrains the CDA entryRelationship class.

This class is a component class it is used to link observation class.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="COMP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "COMP".
[1..1] [M] contextConductionInd (BL)
{ Fixed="true" }

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

  • The XML attribute contextConductionInd is fixed to "true".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#entryRelationship2" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#entryRelationship2".
[1..1] reasonText (ReasonText)
A link to the reason text class.
[0..1] entryRelationship3

This template class constrains the CDA entryRelationship class.

This class is a component class it is used to link observation class.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="COMP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "COMP".
[1..1] [M] contextConductionInd (BL)
{ Fixed="true" }

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

  • The XML attribute contextConductionInd is fixed to "true".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#entryRelationship3" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#entryRelationship3".
[1..1] supplementaryText (SupplementaryText)
A link to supplementary text class.
SupplementaryText

This template class constrains the CDA Observation entry class.

This class represents the supplementary text.
Used by: Screening
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:CDAObservationType } )
{ Fixed="BSSTX" }

Model Attribute Description

The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as the blood spot supplementary text observation, the detail of which is carried in the HL7 attribute value of this class.

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value "BSSTX"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.220"
  • The XML attribute displayName shall carry the description associated with the code.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#supplementaryText" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2".
  • The XML attribute extension is fixed to "COCD_TP146005GB03#supplementaryText".
[1..1] [M] value (ST)

Model Attribute Description

The HL7 attribute value is used to carry the information about detail about the supplementary text, this value is associated with the HL7 attribute code of this class.

Implementation in XML Instance
  • The XML attribute xsi:type shall contain the value "ST".
  • The XML element value shall contain the information.
ReasonText

This template class constrains the CDA Observation entry class.

This class represents the reason text.
Used by: Screening
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:CDAObservationType } )
{ Fixed="BSRTX" }

Model Attribute Description

The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as the blood spot reason text observation, the detail of which is carried in the HL7 attribute value of this class.

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value "BSRTX"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.220"
  • The XML attribute displayName shall carry the description associated with the code.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#reasonText" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#reasonText".
[1..1] [M] value (ST)

Model Attribute Description

The HL7 attribute value is used to carry the information about detail about the reason text, this value is associated with the HL7 attribute code of this class.

Implementation in XML Instance

  • The XML attribute xsi:type shall contain the value "ST".
  • The XML element value shall contain the information.
ScreeningSubStatus

This template class constrains the CDA Observation entry class.

This class represents the screening sub status.
Used by: Screening
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:CDAObservationType } )
{ Fixed="BSSSS" }

Model Attribute Description

The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as a blood spot screening sub status observation, the detail of which is carried in the HL7 attribute value of this class.

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value "BSSSS"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.220"
  • The XML attribute displayName shall carry the description associated with the code.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#screeningSubStatus" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#screeningSubStatus".
[1..1] [M] value (CD { CWE:BSScreeningStatusSubCodes } )
{ Default="BSScreeningStatusSubCodes" }

Model Attribute Description

The HL7 attribute value uses the code from the BSScreeningStatusSubCodes vocabulary to describe this as a newborn blood spot screening result sub status, this value is associated with the HL7 attribute code of this class.

Implementation in XML Instance

The Concept Descriptor (CD) data type shall be used to carry this information in the XML element value as follows:

  • The XML attribute value shall contain the value from the BSScreeningStatusSubCodes vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.487"
  • The XML attribute displayName shall carry the description associated with the code stated in the BSScreeningStatusSubCodes vocabulary.
  • The XML element translation may be populated as follows to support alternate coding system representation of the same information.
    • For the Version 2 of the Read Codes (commonly known as READ2):
      • The XML attribute code shall contain the value from the READ2 coding scheme.
      • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.6.2".
      • The XML attribute displayName may carry the description associated with the code.
    • For the Version 3 of the Read Codes (commonly known as Clinical Terms Version 3,CTV3) coding:
      • The XML attribute code shall contain the value from the CTV3 coding scheme.
      • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.14".
      • The XML attribute displayName may carry the description associated with the code.
    • For SNOMED CT concepts
      • The XML attribute code shall contain the value from the NewbornBloodSpotScreeningResultSubstatusSnCT subset.
      • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15".
      • The XML attribute displayName shall carry the description associated with the concept stated in the NewbornBloodSpotScreeningResultSubstatusSnCT subset. It is recommended that the preferred term is used to populate this attribute
    • For other coding systems (schemes):
      • The XML attribute code shall contain the value from the that coding scheme.
      • The XML attribute codeSystem shall contain the OID for that coding scheme.
      • The XML attribute displayName may carry the description associated with the code.
LocStatus

This template class constrains the CDA Observation entry class.

This class represents the location status.
Used by: BloodSpotScreening
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:CDAObservationType } )
{ Fixed="LOCSTS" }

Model Attribute Description

The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as a location status observation, the detail of which is carried in the HL7 attribute value of this class.

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value "LOCSTS"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.220"
  • The XML attribute displayName shall carry the description associated with the code.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#locStatus" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#locStatus".
[1..1] [M] value (CV { CNE:BSScreeningLocStatus } )

Model Attribute Description

The HL7 attribute value uses a code from the BSScreeningLocStatus vocabulary to describe this as a blood spot screening location status, this is value associated with the HL7 attribute code of this class.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain a value from the BSScreeningLocStatus vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.486"
  • The XML attribute displayName shall carry the description associated with the code.
SecPerformerChoice
An abstract placeholder for the templates for a secondary performer.
Used by: BloodSpotScreening
[1..1] : Template3
PerformerChoice
An abstract placeholder for the templates for a performer.
Used by: BloodSpotScreening
[1..1] : Template2
PrvLabCardSerialNum

This template class constrains the CDA Observation entry class.

This class represents the previous laboratory card serial number.
Used by: BloodSpotScreening
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:CDAObservationType } )
{ Fixed="LABSNP" }

Model Attribute Description

The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as a previous lab serial number observation, the detail of which is carried in the HL7 attribute value of this class.

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value "LAPSNP"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.220"
  • The XML attribute displayName shall carry the description associated with the code.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#prvLabCardSerialNum" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#prvLabCardSerialNum".
[1..1] [M] value (ST)

Model Attribute Description

The HL7 attribute value is used to carry the information about detail about the previous laboratory card serial number, this value is associated with the HL7 attribute code of this class.

Implementation in XML Instance

The XML element value should be populated using the ST data type as follows:
  • The XML attribute xsi:type shall contain the value "ST".
  • The XML element value shall contain the information.
LabCardSerialNum

This template class constrains the CDA Observation entry class.

This class represents the laboratory card serial number.
Used by: BloodSpotScreening
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:CDAObservationType } )
{ Fixed="LABSNO" }

Model Attribute Description

The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as a laboratory card serial number observation, the detail of which is carried in the HL7 attribute value of this class.

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value "LABSNO"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.220"
  • The XML attribute displayName shall carry the description associated with the code.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146005GB03#labCardSerialNum" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146005GB03#labCardSerialNum".
[1..1] [M] value (ST)

Model Attribute Description

The HL7 attribute value is used to carry the information about detail about laboratory card serial number, this value is associated with the HL7 attribute code of this class.

Implementation in XML Instance

The XML element value should be populated using the ST data type as follows:
  • The XML attribute xsi:type shall contain the value "ST".
  • The XML element value shall contain the information.